home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / language / iconv8_e.arc / DOCS.ARC / IPD136.DOC < prev    next >
Text File  |  1985-11-20  |  19KB  |  661 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                Version 8 of Icon for the Atari ST
  8.  
  9.                         Ralph E. Griswold
  10.     Department of Computer Science, The University of Arizona
  11.  
  12.  
  13.  
  14. 1.__Introduction
  15.  
  16.    Icon for the Atari ST is designed to run on both the 520 and
  17. 1040 models, but the limited amount of memory on the 520 makes
  18. its use there problematical for Version 8, which is larger than
  19. previous versions.  Icon for the the Atari ST is designed to run
  20. under a command-line processor, such as ASH.  This document
  21. assumes the use of ASH, although other command-line processors
  22. can be used.
  23.  
  24.    Version 8 of Icon for the Atari ST is distributed on a
  25. single-sided diskette, which includes executable binary files,
  26. ASH, a few test programs, and documentation in machine-readable
  27. form. Printed documentation is included with diskettes distri-
  28. buted by the Icon Project at the University of Arizona.
  29.  
  30.    This implementation of Icon is in the public domain and may be
  31. copied and used without restriction.  The Icon Project makes no
  32. warranties of any kind as to the correctness of this material or
  33. its suitability for any application.  The responsibility for the
  34. use of Icon lies entirely with the user.
  35.  
  36.  
  37. 2.__Documentation
  38.  
  39.    The basic reference for the Icon programming language is the
  40. book
  41.  
  42.      The Icon Programming Language, second edition, Ralph E.
  43.      Griswold and Madge T. Griswold, Prentice-Hall, Inc., Engle-
  44.      wood Cliffs, New Jersey, 1990. 365 pages. ISBN 0-13-447889-
  45.      4. $29.95.
  46.  
  47. This book is available from the Icon Project at the University of
  48. Arizona. It also can be ordered through any bookstore that han-
  49. dles special orders or by telephone directly from Prentice-Hall:
  50. (201) 767-9520.
  51.  
  52.    Note that the first edition of this book, published in 1983,
  53. describes an older version of Icon and does not contain informa-
  54. tion about many of the features of Version 8.
  55.  
  56.    A brief overview of Icon is contained in technical report TR
  57. 90-6 [1] (tr90-6.doc on the distribution diskette). Features that
  58. have been added to Icon since the book was written are described
  59. in TR 90-1 [2] (tr90-1.doc on the distribution diskette).  These
  60. technical reports, together with this document (ipd136.doc on
  61.  
  62.  
  63.  
  64. IPD136                        - 1 -                 April 2, 1990
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73. this diskette), provide enough information to write and run sim-
  74. ple Icon programs, but persons who intend to use Icon extensively
  75. will need the book.
  76.  
  77.  
  78. 3.__Installing_Icon_on_the_Atari_ST
  79.  
  80.    Two executable binary files are needed to run Icon:
  81.  
  82.         icont.prg   translator and linker
  83.         iconx.prg   executor
  84.  
  85. These files should be located at a place on the PATH specifica-
  86. tion for your command-line processor.  Because of the way path
  87. searching is done, it is advisable to place these files in the
  88. root directory of one of your devices.
  89.  
  90.    Most of the distribution files are packaged in ARC format. A
  91. copy of ARC is included on the distribution diskette. The distri-
  92. bution files are:
  93.  
  94.         arc.prg      archiving utility
  95.         icon.arc     Icon executable binaries [214KB]
  96.         samples.arc  Icon programs and data [2KB]
  97.         docs.arc     documents [139KB]
  98.         readme       installation overview and recent notes
  99.         ash.prg      ASH
  100.         ash.hlp      ASH help file
  101.         ash.ini      ASH initialization file
  102.  
  103. The figures in brackets give the approximate amount of disk space
  104. needed when the files are extracted from their archives.
  105.  
  106.    First copy arc.prg to a place on your path.  To install the
  107. .prg files, set your current directory to the desired place and
  108. dearchive the files using arc on the distribution diskette*. For
  109. example, if the distribution diskette is in drive a:, the follow-
  110. ing will do:
  111.  
  112.         arc x a:icon.arc
  113.  
  114. The same technique can be used for extracting the remaining
  115. archived files.
  116.  
  117.  
  118.  
  119.  
  120. __________________________
  121. *If you are not familiar with the capabilities of  arc,  you
  122. can get a brief summary by
  123.  
  124.         arc h
  125.  
  126.  
  127.  
  128.  
  129.  
  130. IPD136                        - 2 -                 April 2, 1990
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139. 4.__Running_Icon_on_the_Atari_ST_-_Basic_Information
  140.  
  141.    Files containing Icon programs must have the extension .icn.
  142. Such files should be plain text files (without line numbers or
  143. other extraneous information).  The command processor icont runs
  144. icont and ilink to produce an ``icode'' file that can be executed
  145. by iconx.  For example, an Icon program in the file prog.icn is
  146. translated and linked by
  147.  
  148.         icont prog.icn
  149.  
  150. The result is an icode file with the name prog.icx.  This file
  151. can be run by
  152.  
  153.         iconx prog.icx
  154.  
  155.  
  156.    The extensions .icn and .icx are optional. For example, it is
  157. sufficient to use
  158.  
  159.         icont prog
  160.  
  161. and
  162.  
  163.         iconx prog
  164.  
  165.  
  166.    If input or output is redirected, i/o redirection must appear
  167. at the beginning of the arguments for iconx, as in
  168.  
  169.         iconx <prog.dat prog
  170.  
  171.  
  172.  
  173. 5.__Testing_the_Installation
  174.  
  175.    There are a few programs on the distribution diskette that can
  176. be used for testing the installation and getting a feel for run-
  177. ning Icon:
  178.  
  179.      hello.icn   This program prints the Icon version number,
  180.                  time, and date. Run this test as
  181.  
  182.                          icont hello
  183.                          iconx hello
  184.  
  185.  
  186.      cross.icn   This program prints all the ways that two words
  187.                  intersect in a common character. The file
  188.                  cross.dat contains typical data. Run this test
  189.                  as
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196. IPD136                        - 3 -                 April 2, 1990
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.                          icont cross
  206.                          iconx <cross.dat cross
  207.  
  208.  
  209.      meander.icn This program prints the ``meandering strings''
  210.                  that contain all subsequences of a specified
  211.                  length from a given set of characters. Run this
  212.                  test as
  213.  
  214.                          icont meander
  215.                          iconx <meander.dat meander
  216.  
  217.  
  218.      roman.icn   This program converts Arabic numerals to Roman
  219.                  numerals. Run this test as
  220.  
  221.                          icont roman
  222.                          iconx roman
  223.  
  224.                  and provide some Arabic numbers from your con-
  225.                  sole.
  226.  
  227. If these tests work, your installation is probably correct and
  228. you should have a running version of Icon.
  229.  
  230.  
  231. 6.__More_on_Running_Icon
  232.  
  233.    For simple applications, the instructions for running Icon
  234. given in Section 4 may be adequate. The icont command processor
  235. supports a variety of options that may be useful in special
  236. situations.  There also are several aspects of execution that can
  237. be controlled with environment variables.  These are listed here.
  238. If you are new to Icon, you may wish to skip this section on the
  239. first reading but come back to it if you find the need for more
  240. control over the translation and execution of Icon programs.
  241.  
  242. 6.1__Arguments
  243.  
  244.    Arguments can be passed to the Icon program by appending them
  245. to the command line.  Such arguments are passed to the main pro-
  246. cedure as a list of strings.  For example,
  247.  
  248.         iconx prog text.dat log.dat
  249.  
  250. runs the icode file prog.icx, passing its main procedure a list
  251. of two strings, "text.dat" and "log.dat".  These arguments might
  252. be the names of files that prog.icn reads from and writes to. For
  253. example, the main procedure might begin as follows:
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262. IPD136                        - 4 -                 April 2, 1990
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.         procedure main(a)
  272.            in := open(a[1]) | stop("cannot open input file")
  273.            out := open(a[2],"w") | stop("cannot open output file")
  274.                        .
  275.                        .
  276.                        .
  277.  
  278.  
  279. 6.2__The_Command_Processor
  280.  
  281.    The command processor icont can accept several Icon source
  282. files at one time.  When several files are given, they are
  283. translated and combined into a single icode file whose name is
  284. derived from the name of the first file.  For example,
  285.  
  286.         icont prog1 prog2
  287.  
  288. translates and links the files